Documents docker image flow #2345
Conversation
|
@bmuenzenmeyer any updates here? Do you need support from my side? |
|
I think a code owner here needs to merge it if it's of value. Then I'd find a place on the website to link it too. |
sxa
left a comment
sxa
left a comment
There was a problem hiding this comment.
It may be worth having this in a separate file in the docs folder and linking to it from here. This is definitely valuable information. Noting that there is work to decouple of the Alpine releases at the moment so some of this will need to be updated soon too.
It's also worth noting that there are non-x64 Alpine images which we push up which are not depedendent on the unofficial-builds. These are arguably one tier lower than even the unofficial builds in terms of how they are supported, but they would not have an explicit dependency on the unofficial-builds being completed.
There was a problem hiding this comment.
Pull request overview
This PR documents the automated Docker image creation and publishing flow for the nodejs/docker-node repository. The PR adds a new "Image Creation Automation" section to the CONTRIBUTING.md file that explains how the project automatically detects new Node.js releases and publishes them to Docker Hub. Additionally, it fixes a spelling error in update.sh.
Changes:
- Fixed spelling error: "architecure" → "architecture" in update.sh
- Added new "Image Creation Automation" section to CONTRIBUTING.md documenting the automated workflow for detecting, building, and publishing Docker images
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| update.sh | Corrected spelling of "architecture" in a comment |
| CONTRIBUTING.md | Added new section documenting the automated image creation workflow with links to relevant workflows and scripts |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Image Creation Automation | ||
|
|
||
| - Every 15 minutes, the [workflow](https://github.com/nodejs/docker-node/blob/main/.github/workflows/automatic-updates.yml) within the [nodejs/docker-node](https://github.com/nodejs/docker-node) repo [checks](https://github.com/nodejs/docker-node/blob/main/build-automation.mjs) for new versions of Node.js [published to the website's `index.json` file](https://nodejs.org/download/release/index.json). | ||
| - If found, it also checks for an [unofficial musl/Alpline build](https://unofficial-builds.nodejs.org/download/release/index.json). |
There was a problem hiding this comment.
Typo: "Alpline" should be "Alpine".
| - If found, it also checks for an [unofficial musl/Alpline build](https://unofficial-builds.nodejs.org/download/release/index.json). | |
| - If found, it also checks for an [unofficial musl/Alpine build](https://unofficial-builds.nodejs.org/download/release/index.json). |
| - Every 15 minutes, the [workflow](https://github.com/nodejs/docker-node/blob/main/.github/workflows/automatic-updates.yml) within the [nodejs/docker-node](https://github.com/nodejs/docker-node) repo [checks](https://github.com/nodejs/docker-node/blob/main/build-automation.mjs) for new versions of Node.js [published to the website's `index.json` file](https://nodejs.org/download/release/index.json). | ||
| - If found, it also checks for an [unofficial musl/Alpline build](https://unofficial-builds.nodejs.org/download/release/index.json). | ||
| - If found, the [update script](https://github.com/nodejs/docker-node/blob/main/update.sh) runs | ||
| - The workflow opens a pull request either automatically via [nodejs-github-bot](https://github.com/nodejs-github-bot) or in some cases manually, such as when there is a new major releases. |
There was a problem hiding this comment.
Grammar error: "major releases" should be "major release" (singular) to match "there is a new".
| - The workflow opens a pull request either automatically via [nodejs-github-bot](https://github.com/nodejs-github-bot) or in some cases manually, such as when there is a new major releases. | |
| - The workflow opens a pull request either automatically via [nodejs-github-bot](https://github.com/nodejs-github-bot) or in some cases manually, such as when there is a new major release. |
4 participants
Description
Documents docker image flow. I elected not to use mermaid as I thought it was a bit too limiting.
Motivation and Context
I get asked this question often. With the most recent security release, I was asked three times within my company how this works.
I talked to @nschonni within #2339 to get some initial alignment.
Testing Details
Example Output(if appropriate)
Types of changes
Checklist